[lldb] Make step/s alias for new _regexp-step #153984
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduces `_regexp-step`, a regex command which allows for stepping into a target
function. This change updates `step` and `s` to be aliases for `_regexp-step`.
The existing `sif` command ("Step Into Function") is not well known amongst users. This
change makes `step` and `s` work like `sif`, taking an optional function name.
This is implemented to not break uses of `step` or `s` with a flag, for example running
`step -r func_to_avoid` works as expected.
kastiglione
requested review from
adrian-prantl,
jasonmolenda,
jimingham and
medismailben
Member
|
@llvm/pr-subscribers-lldb Author: Dave Lee (kastiglione) ChangesIntroduces The existing This is implemented to not break uses of Full diff: https://github.com/llvm/llvm-project/pull/153984.diff 2 Files Affected:
diff --git a/lldb/source/Interpreter/CommandInterpreter.cpp b/lldb/source/Interpreter/CommandInterpreter.cpp
index a0080cfff57c1..b1fd3e7984aa4 100644
--- a/lldb/source/Interpreter/CommandInterpreter.cpp
+++ b/lldb/source/Interpreter/CommandInterpreter.cpp
@@ -335,7 +335,7 @@ void CommandInterpreter::Initialize() {
AddAlias("ni", cmd_obj_sp);
}
- cmd_obj_sp = GetCommandSPExact("thread step-in");
+ cmd_obj_sp = GetCommandSPExact("_regexp-step");
if (cmd_obj_sp) {
AddAlias("s", cmd_obj_sp);
AddAlias("step", cmd_obj_sp);
@@ -946,6 +946,26 @@ void CommandInterpreter::LoadCommandDictionary() {
jump_regex_cmd_sp;
}
}
+
+ std::shared_ptr<CommandObjectRegexCommand> step_regex_cmd_sp(
+ new CommandObjectRegexCommand(
+ *this, "_regexp-step",
+ "Single step, optionally to a specific function.",
+ "\n"
+ "_regexp-step // Single step\n"
+ "_regexp-step <function-name> // Step into the named function\n",
+ 0, false));
+ if (step_regex_cmd_sp) {
+ if (step_regex_cmd_sp->AddRegexCommand("^$", "thread step-in") &&
+ step_regex_cmd_sp->AddRegexCommand("^[[:space:]]*(-.*)$",
+ "thread step-in %1") &&
+ step_regex_cmd_sp->AddRegexCommand(
+ "^[[:space:]]*(.+)[[:space:]]*$",
+ "thread step-in --end-linenumber block --step-in-target %1")) {
+ m_command_dict[std::string(step_regex_cmd_sp->GetCommandName())] =
+ step_regex_cmd_sp;
+ }
+ }
}
int CommandInterpreter::GetCommandNamesMatchingPartialString(
diff --git a/lldb/test/API/lang/c/step-target/TestStepTarget.py b/lldb/test/API/lang/c/step-target/TestStepTarget.py
index 2da0a7894655d..e5bd64d8927af 100644
--- a/lldb/test/API/lang/c/step-target/TestStepTarget.py
+++ b/lldb/test/API/lang/c/step-target/TestStepTarget.py
@@ -83,14 +83,16 @@ def test_with_end_line_deeper(self):
@expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr32343")
def test_with_command_and_block(self):
"""Test stepping over vrs. hitting breakpoints & subsequent stepping in various forms."""
+ self.do_command_and_block()
+ self.do_command_and_block(True)
+ def do_command_and_block(self, use_regexp_step=False):
thread = self.get_to_start()
- result = lldb.SBCommandReturnObject()
- self.dbg.GetCommandInterpreter().HandleCommand(
- 'thread step-in -t "lotsOfArgs" -e block', result
- )
- self.assertTrue(result.Succeeded(), "thread step-in command succeeded.")
+ if use_regexp_step:
+ self.expect("s lotsOfArgs")
+ else:
+ self.expect('thread step-in -t "lotsOfArgs" -e block')
frame = thread.frames[0]
self.assertEqual(frame.name, "lotsOfArgs", "Stepped to lotsOfArgs.")
@@ -98,14 +100,16 @@ def test_with_command_and_block(self):
@expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr32343")
def test_with_command_and_block_and_bad_name(self):
"""Test stepping over vrs. hitting breakpoints & subsequent stepping in various forms."""
+ self.do_with_command_and_block_and_bad_name()
+ self.do_with_command_and_block_and_bad_name(True)
+ def do_with_command_and_block_and_bad_name(self, use_regexp_step=False):
thread = self.get_to_start()
- result = lldb.SBCommandReturnObject()
- self.dbg.GetCommandInterpreter().HandleCommand(
- 'thread step-in -t "lotsOfArgsssss" -e block', result
- )
- self.assertTrue(result.Succeeded(), "thread step-in command succeeded.")
+ if use_regexp_step:
+ self.expect("s lotsOfArgsssss")
+ else:
+ self.expect('thread step-in -t "lotsOfArgsssss" -e block')
frame = thread.frames[0]
|
JDevlieghere
approved these changes
Aug 18, 2025
Member
JDevlieghere
left a comment
JDevlieghere
left a comment
There was a problem hiding this comment.
LGTM, this looks useful!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduces
_regexp-step, a step command which additionally allows for stepping into a target function. This change updatesstepandsto be aliases for_regexp-step.The existing
sifalias ("Step Into Function") is not well known amongst users. This change updatesstepandsto also work likesif, taking an optional function name.This is implemented to not break uses of
steporswith a flag, for example runningstep -r func_to_avoidworks as expected.